<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>uprgae</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/uprgae-console/">UPR-GAE console</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Module&nbsp;uprgae
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="uprgae-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module uprgae</h1><p class="nomargin-top"><span class="codelink"><a href="uprgae-pysrc.html">source&nbsp;code</a></span></p>
<p>Module to ease management of domains under Google Apps for Education 
  (GAE).</p>

<hr />
<div class="fields">      <p><strong>Version:</strong>
        0.7
      </p>
      <p><strong>Author:</strong>
        Edwood Ocasio
      </p>
      <p><strong>License:</strong>
        GPL v3.0
      </p>
</div><!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="uprgae-module.html#mountfs" class="summary-sig-name">mountfs</a>(<span class="summary-sig-arg">mountpoint</span>)</span><br />
      Mounts GAE services as a filesystem using 'goofs' module</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#mountfs">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="uprgae-module.html#umountfs" class="summary-sig-name">umountfs</a>(<span class="summary-sig-arg">mountpoint</span>)</span><br />
      Dismounts GAE services as a filesystem using 'goofs' module</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#umountfs">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="about"></a><span class="summary-sig-name">about</span>()</span><br />
      Shows uprgae module information.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#about">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="cls"></a><span class="summary-sig-name">cls</span>()</span><br />
      Clears the screen.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#cls">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="uprgae-module.html#report" class="summary-sig-name">report</a>(<span class="summary-sig-arg">report_name</span>,
        <span class="summary-sig-arg">report_date</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">page</span>=<span class="summary-sig-default">None</span>)</span><br />
      Retrieves named report for date specified.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#report">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="printheader"></a><span class="summary-sig-name">printheader</span>()</span><br />
      Prints administrative console header.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#printheader">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="uprgae-module.html#login" class="summary-sig-name">login</a>()</span><br />
      Asks for administrator's credentials.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#login">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="uprgae-module.html#loadconf" class="summary-sig-name">loadconf</a>(<span class="summary-sig-arg">configfile</span>)</span><br />
      Reads configuration specified file and saves its content in a dictionary.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#loadconf">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="uprgae-module.html#show" class="summary-sig-name">show</a>(<span class="summary-sig-arg">user_name</span>)</span><br />
      Reports all available information from specified user.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#show">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="get"></a><span class="summary-sig-name">get</span>(<span class="summary-sig-arg">user_name</span>)</span><br />
      Returns userentry object for the specified user.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#get">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="update"></a><span class="summary-sig-name">update</span>(<span class="summary-sig-arg">user_name</span>)</span><br />
      Updates information for specified user .</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#update">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="setadmin"></a><span class="summary-sig-name">setadmin</span>(<span class="summary-sig-arg">user_name</span>)</span><br />
      Sets administration privileges a given user.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#setadmin">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="exist"></a><span class="summary-sig-name">exist</span>(<span class="summary-sig-arg">user_name</span>)</span><br />
      Returns True if user exists, False if not</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#exist">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="uprgae-module.html#genusername" class="summary-sig-name">genusername</a>(<span class="summary-sig-arg">given_name</span>,
        <span class="summary-sig-arg">family_name</span>,
        <span class="summary-sig-arg">generator</span>=<span class="summary-sig-default">0</span>)</span><br />
      Generates suitable usernames alternatives.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#genusername">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="create"></a><span class="summary-sig-name">create</span>()</span><br />
      Creates a new user.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#create">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="delete"></a><span class="summary-sig-name">delete</span>(<span class="summary-sig-arg">user_name</span>)</span><br />
      Deletes user_name account.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#delete">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="suspend"></a><span class="summary-sig-name">suspend</span>(<span class="summary-sig-arg">user_name</span>)</span><br />
      Suspends user_name account.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#suspend">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="reactivate"></a><span class="summary-sig-name">reactivate</span>(<span class="summary-sig-arg">user_name</span>)</span><br />
      Reactivates (restores) specified user after a suspension.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#reactivate">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="chpass"></a><span class="summary-sig-name">chpass</span>(<span class="summary-sig-arg">user_name</span>)</span><br />
      Changes user password.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#chpass">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="uprgae-module.html#search" class="summary-sig-name">search</a>(<span class="summary-sig-arg">criteria</span>)</span><br />
      Searches for accounts matching the criteria.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#search">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="uprgae-module.html#getallusers" class="summary-sig-name">getallusers</a>()</span><br />
      Retrieves an XML file with all domain accounts information.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#getallusers">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="commands"></a><span class="summary-sig-name">commands</span>()</span><br />
      Retrieves a list of currently supported commands.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#commands">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="testlogin"></a><span class="summary-sig-name">testlogin</span>()</span><br />
      Tests GAE service after login.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#testlogin">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="test"></a><span class="summary-sig-name">test</span>()</span><br />
      Tests UPR-GAE configuration</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#test">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="createlist"></a><span class="summary-sig-name">createlist</span>(<span class="summary-sig-arg">list_name</span>)</span><br />
      Creates empty email list with given name.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#createlist">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="deletelist"></a><span class="summary-sig-name">deletelist</span>(<span class="summary-sig-arg">list_name</span>)</span><br />
      Deletes email list with given name.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#deletelist">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="getlist"></a><span class="summary-sig-name">getlist</span>(<span class="summary-sig-arg">list_name</span>)</span><br />
      Returns EmailListEntry object for the specified list.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#getlist">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="addtolist"></a><span class="summary-sig-name">addtolist</span>(<span class="summary-sig-arg">user_name</span>,
        <span class="summary-sig-arg">list_name</span>)</span><br />
      Adds  specified user to list list_name.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#addtolist">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="removefromlist"></a><span class="summary-sig-name">removefromlist</span>(<span class="summary-sig-arg">user_name</span>,
        <span class="summary-sig-arg">list_name</span>)</span><br />
      Removes specified user from list list_name.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#removefromlist">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="uprgae-module.html#getmemberlist" class="summary-sig-name">getmemberlist</a>(<span class="summary-sig-arg">list_name</span>)</span><br />
      Gets all members of the specified list in an EmailListRecipientFeed 
      obect.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#getmemberlist">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="uprgae-module.html#addtolistf" class="summary-sig-name">addtolistf</a>(<span class="summary-sig-arg">filename</span>,
        <span class="summary-sig-arg">list_name</span>)</span><br />
      Adds members to list_name from a file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#addtolistf">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="uprgae-module.html#exportlist" class="summary-sig-name">exportlist</a>(<span class="summary-sig-arg">list_name</span>,
        <span class="summary-sig-arg">filename</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">export.csv</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">delimiter</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">\n</code><code class="variable-quote">'</code></span>)</span><br />
      Exports specified email list member addresses to a file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#exportlist">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="uprgae-module.html#createf" class="summary-sig-name">createf</a>(<span class="summary-sig-arg">filename</span>,
        <span class="summary-sig-arg">listonly</span>=<span class="summary-sig-default">False</span>)</span><br />
      Create users from a file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#createf">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="uprgae-module.html#deletef" class="summary-sig-name">deletef</a>(<span class="summary-sig-arg">filename</span>)</span><br />
      Delete users listed in a file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#deletef">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="uprgae-module.html#suspendf" class="summary-sig-name">suspendf</a>(<span class="summary-sig-arg">filename</span>)</span><br />
      Suspends users listed in a file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#suspendf">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="uprgae-module.html#reactivatef" class="summary-sig-name">reactivatef</a>(<span class="summary-sig-arg">filename</span>)</span><br />
      Reactivates users listed in a file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#reactivatef">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="uprgae-module.html#genpassword" class="summary-sig-name">genpassword</a>()</span><br />
      Password generator.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#genpassword">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="setlang"></a><span class="summary-sig-name">setlang</span>(<span class="summary-sig-arg">lang</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="uprgae-pysrc.html#setlang">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="uprgae-module.html#uprgae_Warnings" class="summary-name">uprgae_Warnings</a> = <code title="'''Modules \'goofs\' or \'fuse\' are not installed.  However, you stil\
l can use UPR-GAE console ;). 
'''"><code class="variable-quote">'</code><code class="variable-string">Modules \'goofs\' or \'fuse\' are not insta</code><code class="variable-ellipsis">...</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="DEFAULT_LOCALE_DIR"></a><span class="summary-name">DEFAULT_LOCALE_DIR</span> = <code title="'/usr/share/locale'"><code class="variable-quote">'</code><code class="variable-string">/usr/share/locale</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="LANGUAGES"></a><span class="summary-name">LANGUAGES</span> = <code title="['es', 'en']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">es</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">en</code><code class="variable-quote">'</code><code class="variable-group">]</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="FUTURE_FEATURE"></a><span class="summary-name">FUTURE_FEATURE</span> = <code title="'This will be a future feature.'"><code class="variable-quote">'</code><code class="variable-string">This will be a future feature.</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="USERLISTFILE"></a><span class="summary-name">USERLISTFILE</span> = <code title="'usuarios.gae'"><code class="variable-quote">'</code><code class="variable-string">usuarios.gae</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="uprgae-module.html#NAMESPACES" class="summary-name">NAMESPACES</a> = <code title="['http://www.w3.org/2005/Atom', 'http://schemas.google.com/apps/2006']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">http://www.w3.org/2005/Atom</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">http://schemas.g</code><code class="variable-ellipsis">...</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="USERNAME_GENERATOR_NUMSEQUENCE"></a><span class="summary-name">USERNAME_GENERATOR_NUMSEQUENCE</span> = <code title="0">0</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="USERNAME_GENERATOR_ALPHASEQUENCE"></a><span class="summary-name">USERNAME_GENERATOR_ALPHASEQUENCE</span> = <code title="1">1</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="USERNAME_GENERATOR_NUMRANDOM"></a><span class="summary-name">USERNAME_GENERATOR_NUMRANDOM</span> = <code title="2">2</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="USERNAME_GENERATOR_ALPHARANDOM"></a><span class="summary-name">USERNAME_GENERATOR_ALPHARANDOM</span> = <code title="3">3</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="PASSWORD_DEFAULT_LENGTH"></a><span class="summary-name">PASSWORD_DEFAULT_LENGTH</span> = <code title="8">8</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="uprgae-module.html#REPORTNAMES" class="summary-name">REPORTNAMES</a> = <code title="['accounts', 'disk_space', 'summary', 'activity', 'email_clients']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">accounts</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">disk_space</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">summary</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">activity</code><code class="variable-quote">'</code><code class="variable-ellipsis">...</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="HOME"></a><span class="summary-name">HOME</span> = <code title="None">None</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="GOOFS_CACHE"></a><span class="summary-name">GOOFS_CACHE</span> = <code title="None">None</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="PHOTOS"></a><span class="summary-name">PHOTOS</span> = <code title="None">None</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="PHOTOS_DIR"></a><span class="summary-name">PHOTOS_DIR</span> = <code title="None">None</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="PUB_PHOTOS_DIR"></a><span class="summary-name">PUB_PHOTOS_DIR</span> = <code title="None">None</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="PRIV_PHOTOS_DIR"></a><span class="summary-name">PRIV_PHOTOS_DIR</span> = <code title="None">None</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="GDOCS_DIRS"></a><span class="summary-name">GDOCS_DIRS</span> = <code title="None">None</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="uprgae-module.html#EXT_CTYPE" class="summary-name">EXT_CTYPE</a> = <code title="{'bmp': 'image/bmp',
 'gif': 'image/gif',
 'jpeg': 'image/jpeg',
 'jpg': 'image/jpeg',
 'png': 'image/png'}"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">bmp</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">image/bmp</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">gif</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">image/gif</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">jpeg</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-ellipsis">...</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__email__"></a><span class="summary-name">__email__</span> = <code title="'edwood.ocasio@gae.cayey.upr.edu'"><code class="variable-quote">'</code><code class="variable-string">edwood.ocasio@gae.cayey.upr.edu</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__firstreleasedate__"></a><span class="summary-name">__firstreleasedate__</span> = <code title="'13-Jul-2008'"><code class="variable-quote">'</code><code class="variable-string">13-Jul-2008</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__releasedate__"></a><span class="summary-name">__releasedate__</span> = <code title="'01-Sep-2008'"><code class="variable-quote">'</code><code class="variable-string">01-Sep-2008</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__projecturl__"></a><span class="summary-name">__projecturl__</span> = <code title="'http://code.google.com/p/uprgae-console/'"><code class="variable-quote">'</code><code class="variable-string">http://code.google.com/p/uprgae-console/</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__maillist__"></a><span class="summary-name">__maillist__</span> = <code title="'http://groups.google.com/group/upr-gae-console'"><code class="variable-quote">'</code><code class="variable-string">http://groups.google.com/group/upr-gae-console</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="gaefs"></a><span class="summary-name">gaefs</span> = <code title="None">None</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="uprgae-module.html#config" class="summary-name">config</a> = <code title="{'email': '',
 'lang': 'en',
 'prompt': '',
 'title': '&lt;This title line can be customized in file \'gaeconf\'&gt;'}"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">email</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">lang</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">en</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">prompt</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">title</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">&lt;</code><code class="variable-ellipsis">...</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="adminemail"></a><span class="summary-name">adminemail</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="domain"></a><span class="summary-name">domain</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="adminuser"></a><span class="summary-name">adminuser</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="lang"></a><span class="summary-name">lang</span> = <code title="'en'"><code class="variable-quote">'</code><code class="variable-string">en</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="uprgae-module.html#consoletitle" class="summary-name">consoletitle</a> = <code title="'&lt;This title line can be customized in file \'gaeconf\'&gt;'"><code class="variable-quote">'</code><code class="variable-string">&lt;This title line can be customized in file \'g</code><code class="variable-ellipsis">...</code></code>
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="mountfs"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">mountfs</span>(<span class="sig-arg">mountpoint</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="uprgae-pysrc.html#mountfs">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Mounts GAE services as a filesystem using 'goofs' module</p>
  <p>http://code.google.com/p/goofs</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="umountfs"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">umountfs</span>(<span class="sig-arg">mountpoint</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="uprgae-pysrc.html#umountfs">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Dismounts GAE services as a filesystem using 'goofs' module</p>
  <p>http://code.google.com/p/goofs</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="report"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">report</span>(<span class="sig-arg">report_name</span>,
        <span class="sig-arg">report_date</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">page</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="uprgae-pysrc.html#report">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves named report for date specified.</p>
  <p>Available report_names: 'accounts','disk_space','summary','activity', 
  'email_clients'</p>
  <p>report_date should be in the format YYYY-MM-DD</p>
  <p>If report_date is not specified it returns the latest available 
  report.</p>
  <p>If page is None all report pages are retrieved.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="login"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">login</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="uprgae-pysrc.html#login">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Asks for administrator's credentials.</p>
  <p>Creates object gdata.apps.service.AppsService().</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="loadconf"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">loadconf</span>(<span class="sig-arg">configfile</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="uprgae-pysrc.html#loadconf">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Reads configuration specified file and saves its content in a dictionary.

The configuration file follows this format:

        variable1=value1
        variable2=value2
        

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="show"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">show</span>(<span class="sig-arg">user_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="uprgae-pysrc.html#show">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Reports all available information from specified user.</p>
  <p>Receives _service object created by login()</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="genusername"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">genusername</span>(<span class="sig-arg">given_name</span>,
        <span class="sig-arg">family_name</span>,
        <span class="sig-arg">generator</span>=<span class="sig-default">0</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="uprgae-pysrc.html#genusername">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Generates suitable usernames alternatives.

For now only sequential numerical mutation supported:

        fulano.sutano3
        fulano.sutano4
        prenseja.merleja99

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="search"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">search</span>(<span class="sig-arg">criteria</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="uprgae-pysrc.html#search">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Searches for accounts matching the criteria.</p>
  <p>There is no API to search for accounts in GAE so what this function 
  does is search in the most recent local list generated by getaccounts() 
  which is named 'usuarios.gae' and retrieves a list of matches.</p>
  <p>This is my first approach to this task.</p>
  <p>Possible searching criteria : 'suspended', 'admin', 'activated'</p>
  <p>Anything else is taken as a regular expression that returns a list of 
  matching user_name.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="getallusers"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getallusers</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="uprgae-pysrc.html#getallusers">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves an XML file with all domain accounts information.</p>
  <p>The file is named using date of creation and replaces the last current
  users file named 'usuarios.gae'.  The XML data corresponds to an UserFeed
  object containig an XML representation of many UserEntry objects.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="getmemberlist"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getmemberlist</span>(<span class="sig-arg">list_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="uprgae-pysrc.html#getmemberlist">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gets all members of the specified list in an EmailListRecipientFeed 
  obect.</p>
  <p>Returns a list with user_name of members.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="addtolistf"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">addtolistf</span>(<span class="sig-arg">filename</span>,
        <span class="sig-arg">list_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="uprgae-pysrc.html#addtolistf">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Adds members to list_name from a file.</p>
  <p>Adds users from specified file as members of a list. The file should 
  contain COMPLETE EMAIL addresses, one per line:</p>
  <p>fulano.sutano@gmail.com prensejo.merlejo@gae.cayey.upr.edu</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="exportlist"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">exportlist</span>(<span class="sig-arg">list_name</span>,
        <span class="sig-arg">filename</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">export.csv</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">delimiter</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">\n</code><code class="variable-quote">'</code></span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="uprgae-pysrc.html#exportlist">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Exports specified email list member addresses to a file. 
        
                It uses the new line character as default ('
') which produces
                a file with ONE EMAIL per line. Any delimiter can be specified.
                
                If file name is not given it defaults to 'export.csv'
        
        

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="createf"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">createf</span>(<span class="sig-arg">filename</span>,
        <span class="sig-arg">listonly</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="uprgae-pysrc.html#createf">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">
Create users from a file.

Creates users from specified file in batchmode. The file is in a 
CSV format following this conventions:

The file should contain the given name of the user and her family
name separated by comas:

        Fulano, Sutano
        
The function will assign a suitable username and password. It will
also create a file with the account information.

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="deletef"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">deletef</span>(<span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="uprgae-pysrc.html#deletef">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Delete users listed in a file.</p>
  <p>Deletes users from specified file in batchmode. The file should 
  contain only the usernames, one per line:</p>
  <p>fulano.sutano prensejo.merlejo</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="suspendf"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">suspendf</span>(<span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="uprgae-pysrc.html#suspendf">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Suspends users listed in a file.</p>
  <p>Suspends users from specified file in batchmode. The file should 
  contain only the usernames, one per line:</p>
  <p>fulano.sutano prensejo.merlejo</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="reactivatef"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">reactivatef</span>(<span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="uprgae-pysrc.html#reactivatef">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Reactivates users listed in a file.</p>
  <p>Reactivates users from specified file in batchmode. The file should 
  contain only the usernames, one per line:</p>
  <p>fulano.sutano prensejo.merlejo</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="genpassword"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">genpassword</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="uprgae-pysrc.html#genpassword">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Password generator.</p>
  <p>Simple password generator based on code from this url:</p>
  <p>http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/473852</p>
  <p>Thanks to the author (anonymous).</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== VARIABLES DETAILS ==================== -->
<a name="section-VariablesDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-VariablesDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="uprgae_Warnings"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">uprgae_Warnings</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-quote">'''</code><code class="variable-string">Modules \'goofs\' or \'fuse\' are not installed.  However, you stil</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-string">l can use UPR-GAE console ;). </code>
<code class="variable-string"></code><code class="variable-quote">'''</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="NAMESPACES"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">NAMESPACES</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">http://www.w3.org/2005/Atom</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">http://schemas.google.com/apps/2006</code><code class="variable-quote">'</code><code class="variable-group">]</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="REPORTNAMES"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">REPORTNAMES</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">accounts</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">disk_space</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">summary</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">activity</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">email_clients</code><code class="variable-quote">'</code><code class="variable-group">]</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="EXT_CTYPE"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">EXT_CTYPE</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">bmp</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">image/bmp</code><code class="variable-quote">'</code><code class="variable-op">,</code>
 <code class="variable-quote">'</code><code class="variable-string">gif</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">image/gif</code><code class="variable-quote">'</code><code class="variable-op">,</code>
 <code class="variable-quote">'</code><code class="variable-string">jpeg</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">image/jpeg</code><code class="variable-quote">'</code><code class="variable-op">,</code>
 <code class="variable-quote">'</code><code class="variable-string">jpg</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">image/jpeg</code><code class="variable-quote">'</code><code class="variable-op">,</code>
 <code class="variable-quote">'</code><code class="variable-string">png</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">image/png</code><code class="variable-quote">'</code><code class="variable-group">}</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="config"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">config</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">email</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code><code class="variable-op">,</code>
 <code class="variable-quote">'</code><code class="variable-string">lang</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">en</code><code class="variable-quote">'</code><code class="variable-op">,</code>
 <code class="variable-quote">'</code><code class="variable-string">prompt</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code><code class="variable-op">,</code>
 <code class="variable-quote">'</code><code class="variable-string">title</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">&lt;This title line can be customized in file \'gaeconf\'&gt;</code><code class="variable-quote">'</code><code class="variable-group">}</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="consoletitle"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">consoletitle</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-quote">'</code><code class="variable-string">&lt;This title line can be customized in file \'gaeconf\'&gt;</code><code class="variable-quote">'</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/uprgae-console/">UPR-GAE console</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Mon Sep  1 16:17:53 2008
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
